mDocs Holder SDK/global.mattr.mobilecredential.holder.dto/MobileCredentialMetaData

MobileCredentialMetaData

@Serializable

data class MobileCredentialMetaData(val id: String, val issuerInfo: IssuerInfo, val docType: String, val validityInfo: MobileCredentialValidity, val claims: Map<String, Set<String>>, val msoHash: String, val branding: Branding? = null, val deviceKeyPolicy: DeviceKeyPolicyInfo? = null, val credentialBundleId: String? = null, val credentialReferenceId: String? = null)

Represents a mDoc, excluding any Personally Identifiable Information (PII).

See also

MobileCredential

.

Constructors

MobileCredentialMetaData

constructor(id: String, issuerInfo: IssuerInfo, docType: String, validityInfo: MobileCredentialValidity, claims: Map<String, Set<String>>, msoHash: String, branding: Branding? = null, deviceKeyPolicy: DeviceKeyPolicyInfo? = null, credentialBundleId: String? = null, credentialReferenceId: String? = null)

Properties

val branding: Branding?

Optional branding information for the mDoc.

val claims: Map<String, Set<String>>

A map containing the credential's claims, keyed by namespaces.

credentialBundleId

val credentialBundleId: String?

The credential_bundle_id returned by the issuer in the credential response, when present.

credentialReferenceId

val credentialReferenceId: String?

The credential_reference_id returned by the issuer in the credential response, when present.

deviceKeyPolicy

val deviceKeyPolicy: DeviceKeyPolicyInfo?

Optional policy used for the device key at issuance time, if configured.

val docType: String

The credential's document type (e.g., passport, ID).

val id: String

Unique identifier for the MobileCredentialMetaData.

val issuerInfo: IssuerInfo

Information about the credential's issuer, including commonName and trustedIssuerCertificateId.

val msoHash: String

Unique identifier calculated by sha256 hash of Mobile Security Object. Represented as a Base64 string with no padding.

val validityInfo: MobileCredentialValidity

Information about the validity period of the credential.